Skip to content

fix(om2.0): fixes in type text format #2903

Open
krajorama wants to merge 6 commits intomainfrom
krajo/om2-text-types
Open

fix(om2.0): fixes in type text format #2903
krajorama wants to merge 6 commits intomainfrom
krajo/om2-text-types

Conversation

@krajorama
Copy link
Member

The one major fix is that a gauge histogram doesn't have start time.

@krajorama krajorama added the priority/p2 Candidates for next primary. label Mar 18, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the OpenMetrics 2.0 text-format specification to clarify value constraints for scalar metric types, improve cross-references/examples, and correct GaugeHistogram guidance to align with the data model (notably around Start Timestamp usage).

Changes:

  • Adds explicit “Sample value MUST be a Number” statements for Gauge/Counter/Unknown in the text-format metric type sections.
  • Improves spec text clarity (adds UTF-8 Quoting anchor link, refines example descriptions, adds a note about native bucket values being absolute counts).
  • Adjusts GaugeHistogram text-format examples and descriptions, including removing st@... from a GaugeHistogram example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

dashpole
dashpole previously approved these changes Mar 18, 2026
bwplotka
bwplotka previously approved these changes Mar 20, 2026
Copy link
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM mod nits


Native Bucket values MUST be ordered by their index, and their values MUST be placed in the `negative_buckets` (and/or `positive_buckets`) fields.

> NOTE: Bucket values are absolute counts, as opposed to some implementations that store bucket values as deltas relative to the preceding bucket.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, I was actually curious about it - this differs between float and int in mem/RW proto etc - sounds like it's a simple abs counts in OM 2.0.. for simplicity?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, we decided to not leak internal storage optimization (beyond sparse representation with the spans to avoid huge lines)

@bwplotka bwplotka dismissed stale reviews from dashpole and themself via f353794 March 20, 2026 00:36
krajorama and others added 2 commits March 20, 2026 12:19
The one major fix is that a gauge histogram doesn't have start time.

Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
Change count and sum to `gcount` and `gsum` in the exposition for gauge
histograms. This mirrors OM 1.0 suffixes.

There's too many complications if we don't do this.
The only downside is that the histogram functions in PromQL don't have a
gauge version, but I think we can live with that. Or even add those
later if anyone needs them - which I doubt.

Also fix that gauge histograms model currently doesn't have start
timestamp, but our text format seemed to conflict with this.

Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
@krajorama krajorama force-pushed the krajo/om2-text-types branch from 706e548 to 32bb065 Compare March 20, 2026 11:19
krajorama and others added 2 commits March 20, 2026 13:08
Co-authored-by: Bartlomiej Plotka <bwplotka@gmail.com>
Signed-off-by: George Krajcsovits <krajorama@users.noreply.github.com>
Copy link
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

bwplotka
bwplotka previously approved these changes Mar 20, 2026
krajorama and others added 2 commits March 20, 2026 13:12
Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority/p2 Candidates for next primary.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants